Esx Settings Inventory Reports TransitionSummary Clusters ClusterSummary

Esx Settings Inventory Reports TransitionSummary Clusters ClusterSummary
Esx Settings Inventory Reports TransitionSummary Clusters ClusterSummary

The Esx Settings Inventory Reports TransitionSummary Clusters ClusterSummary schema contains properties that describes the cluster and what software it is currently running. It fetches the software details from all the hosts within the cluster. Along with the software details, it also provides the status of a given cluster with respect to its transition from baseline managed to image managed.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "cluster": "string",
    "last_check_time": "string",
    "uniform_image": false,
    "images": [
        {
            "base_image": {
                "details": {
                    "display_name": "string",
                    "display_version": "string",
                    "release_date": "string",
                    "quick_patch_compatible_versions": {
                        "quick_patch_compatible_versions": "string"
                    }
                },
                "version": "string"
            },
            "add_on": {
                "details": {
                    "display_name": "string",
                    "vendor": "string",
                    "display_version": "string"
                },
                "name": "string",
                "version": "string"
            },
            "components": {
                "components": {
                    "version": "string",
                    "details": {
                        "display_name": "string",
                        "vendor": "string",
                        "display_version": "string"
                    }
                }
            },
            "solutions": {
                "solutions": {
                    "details": {
                        "display_name": "string",
                        "display_version": "string",
                        "components": [
                            {
                                "component": "string",
                                "display_name": "string",
                                "display_version": "string",
                                "vendor": "string"
                            }
                        ]
                    },
                    "version": "string",
                    "components": [
                        {
                            "component": "string"
                        }
                    ]
                }
            },
            "hardware_support": {
                "packages": {
                    "packages": {
                        "pkg": "string",
                        "version": "string"
                    }
                }
            },
            "removed_components": {
                "removed_components": {
                    "version": "string",
                    "details": {
                        "display_name": "string",
                        "vendor": "string",
                        "display_version": "string"
                    }
                }
            },
            "alternative_images": {
                "alternative_images": {
                    "base_image": {
                        "details": {
                            "display_name": "string",
                            "display_version": "string",
                            "release_date": "string",
                            "quick_patch_compatible_versions": {
                                "quick_patch_compatible_versions": "string"
                            }
                        },
                        "version": "string"
                    },
                    "add_on": {
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        },
                        "name": "string",
                        "version": "string"
                    },
                    "components": {
                        "components": {
                            "version": "string",
                            "details": {
                                "display_name": "string",
                                "vendor": "string",
                                "display_version": "string"
                            }
                        }
                    },
                    "solutions": {
                        "solutions": {
                            "details": {
                                "display_name": "string",
                                "display_version": "string",
                                "components": [
                                    {
                                        "component": "string",
                                        "display_name": "string",
                                        "display_version": "string",
                                        "vendor": "string"
                                    }
                                ]
                            },
                            "version": "string",
                            "components": [
                                {
                                    "component": "string"
                                }
                            ]
                        }
                    },
                    "hardware_support": {
                        "packages": {
                            "packages": {
                                "pkg": "string",
                                "version": "string"
                            }
                        }
                    },
                    "removed_components": {
                        "removed_components": {
                            "version": "string",
                            "details": {
                                "display_name": "string",
                                "vendor": "string",
                                "display_version": "string"
                            }
                        }
                    },
                    "display_name": "string",
                    "selection_criteria": {
                        "selection_type": "string",
                        "host_uuids": [
                            "string"
                        ],
                        "host_hardware_spec": {
                            "vendor": "string",
                            "models": [
                                "string"
                            ],
                            "families": [
                                "string"
                            ],
                            "oem_strings": [
                                "string"
                            ]
                        }
                    }
                }
            }
        }
    ],
    "orphan_vibs": false,
    "status": "string",
    "notifications": {
        "info": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "originator": "string",
                "retriable": false
            }
        ],
        "warnings": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "originator": "string",
                "retriable": false
            }
        ],
        "errors": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "resolution": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "originator": "string",
                "retriable": false
            }
        ]
    }
}
string
cluster
Required

Identifier of the cluster

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.

string As date-time As date-time
last_check_time
Required

Defines the timestamp when the last com.vmware.esx.settings.inventory.Inventory#extractInstalledImage operation was executed on a given entity.

This property was added in vSphere API 9.0.0.0.

boolean
uniform_image
Required

Defines if the given entity is having a single image or not.

This property was added in vSphere API 9.0.0.0.

images
Required

Defines the list of unique images found on a given cluster.

This property was added in vSphere API 9.0.0.0.

boolean
orphan_vibs
Required

Defines if any orphan VIBs are found on an entity. If found the user is expected to check the detailed installed-image report of a given entity.

This property was added in vSphere API 9.0.0.0.

string
status
Required

Esx Settings Inventory Reports TransitionSummary Clusters TransitionStatus of a given entity as described in #TransitionStatus.

For more information see: Esx Settings Inventory Reports TransitionSummary Clusters TransitionStatus.

This property was added in vSphere API 9.0.0.0.

notifications
Required

Describes if any notifications were raised for the given entity during the execution of the operation.

This property was added in vSphere API 9.0.0.0.